Throw an error when running integration installs when uv == False but pip is not installed #2930

mennoliefstingh · 2024-08-13T16:34:34Z

Describe changes

I implemented a check for pip being installed when not using the uv flag. This mitigates issue #2929.

Pre-requisites

Please ensure you have done the following:

I have read the CONTRIBUTING.md document.
If my change requires a change to docs, I have updated the documentation accordingly.
I have added tests to cover my changes.
I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
If my changes require changes to the dashboard, these changes are communicated/requested.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Other (add details above)

CLAassistant · 2024-08-13T16:34:40Z

All committers have signed the CLA.

coderabbitai · 2024-08-13T16:34:41Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

mennoliefstingh · 2024-08-13T16:36:28Z

Confirmed to work as expected:

which pip
/Library/Frameworks/Python.framework/Versions/3.11/bin/pip
pip uninstall pip
Found existing installation: pip 24.2
Uninstalling pip-24.2:
  Would remove:
    /Library/Frameworks/Python.framework/Versions/3.11/bin/pip
    /Library/Frameworks/Python.framework/Versions/3.11/bin/pip3
    /Library/Frameworks/Python.framework/Versions/3.11/bin/pip3.11
    /Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/pip-24.2.dist-info/*
    /Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/pip/*
Proceed (Y/n)?
  Successfully uninstalled pip-24.2
pip
zsh: command not found: pip
source .venv/bin/activate
ls
CLA.md              README.md         alembic.ini  infra                            scripts     trivy-secret.yaml
CODE-OF-CONDUCT.md  RELEASE_NOTES.md  docker       pyproject.toml                   src         zen-dev
CONTRIBUTING.md     ROADMAP.md        docs         release-cloudbuild-nightly.yaml  stats.html  zen-test
LICENSE             SECURITY.md       examples     release-cloudbuild.yaml          tests
zenml integration install sklearn -y
Error: Pip is not installed. Please install pip or use the uv flag for package installation.

mennoliefstingh · 2024-08-13T16:39:23Z

Please refer to the linked issue for my bug report.

Additional thoughts:

The uv check (and now pip check too) is repeated three times in integration.py. This might be a good moment to reconsider the dry-kiss dichotomy.
Over those three repetitions of the uv check, the first check has a different error message from the second and third.

schustmi · 2024-08-15T11:07:52Z

src/zenml/cli/integration.py

    from zenml.integrations.registry import integration_registry

    if uv and not is_uv_installed():
        error(
            "UV is not installed but the uv flag was passed in. Please install uv or remove the uv flag."
        )

+    if not uv and not is_pip_installed():
+        error(
+            "Pip is not installed. Please install pip or use the uv flag for package installation."


One tiny comment: it would be nice to also have the (--uv) explanation part in the error message here similar to the others

src/zenml/cli/integration.py

strickvl

Thanks for this! Looks great aside from the one suggestion Michael and I had.

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

strickvl

LGTM!

htahir1 · 2024-08-19T15:04:51Z

@mennoliefstingh looks like you need to run our formating script ... its in scripts/format.sh src/zenml/ after you do pip install -e ".[dev]"

bcdurak

LGTM as well. It seems like the linting is failing due to our quickstart example. I am updating the branch and will let the tests run again.

bcdurak · 2024-08-21T12:29:03Z

Merging this now. Thank you @mennoliefstingh for your contribution ❤️

Check if pip is installed when not using uv flag (zenml-io#2929)

5b87b9c

htahir1 added the bug Something isn't working label Aug 13, 2024

htahir1 requested review from bcdurak and avishniakov August 13, 2024 16:39

schustmi approved these changes Aug 14, 2024

View reviewed changes

schustmi reviewed Aug 15, 2024

View reviewed changes

strickvl reviewed Aug 16, 2024

View reviewed changes

src/zenml/cli/integration.py Outdated Show resolved Hide resolved

strickvl requested changes Aug 16, 2024

View reviewed changes

strickvl added the run-slow-ci label Aug 16, 2024

fix: Include --uv flag hint more explicitly in error message

1a3e28e

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

avishniakov approved these changes Aug 19, 2024

View reviewed changes

strickvl approved these changes Aug 19, 2024

View reviewed changes

bcdurak approved these changes Aug 21, 2024

View reviewed changes

Merge branch 'develop' into fix/warn-on-uv-false-in-uv-venv

826f907

bcdurak merged commit a496fff into zenml-io:develop Aug 21, 2024
68 checks passed

htahir1 mentioned this pull request Aug 22, 2024

[BUG]: integration install fails when using a uv-provisioned venv #2929

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Throw an error when running integration installs when uv == False but pip is not installed #2930

Throw an error when running integration installs when uv == False but pip is not installed #2930

mennoliefstingh commented Aug 13, 2024

CLAassistant commented Aug 13, 2024 •

edited

Loading

coderabbitai bot commented Aug 13, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

mennoliefstingh commented Aug 13, 2024

mennoliefstingh commented Aug 13, 2024

schustmi Aug 15, 2024

strickvl left a comment

strickvl left a comment

htahir1 commented Aug 19, 2024

bcdurak left a comment

bcdurak commented Aug 21, 2024

Throw an error when running integration installs when uv == False but pip is not installed #2930

Throw an error when running integration installs when uv == False but pip is not installed #2930

Conversation

mennoliefstingh commented Aug 13, 2024

Describe changes

Pre-requisites

Types of changes

CLAassistant commented Aug 13, 2024 • edited Loading

coderabbitai bot commented Aug 13, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

mennoliefstingh commented Aug 13, 2024

mennoliefstingh commented Aug 13, 2024

schustmi Aug 15, 2024

Choose a reason for hiding this comment

strickvl left a comment

Choose a reason for hiding this comment

strickvl left a comment

Choose a reason for hiding this comment

htahir1 commented Aug 19, 2024

bcdurak left a comment

Choose a reason for hiding this comment

bcdurak commented Aug 21, 2024

CLAassistant commented Aug 13, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)